Serverpod test server (1.0.0)

Download OpenAPI specification:Download

License: BSD 3-Clause

The server used by Serverpod's internal tests.

asyncTasks

insertRowToSimpleDataAfterDelayAsyncTasks

Authorizations:
serverpodAuth
Request Body schema: application/json
required
num
integer
seconds
integer

Responses

Request samples

Content type
application/json
{
  • "num": 0,
  • "seconds": 0
}

Response samples

Content type
application/json
null

throwExceptionAfterDelayAsyncTasks

Authorizations:
serverpodAuth
Request Body schema: application/json
required
seconds
integer

Responses

Request samples

Content type
application/json
{
  • "seconds": 0
}

Response samples

Content type
application/json
null

authentication

removeAllUsersAuthentication

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

countUsersAuthentication

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

createUserAuthentication

Authorizations:
serverpodAuth
Request Body schema: application/json
required
email
string
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
null

authenticateAuthentication

Authorizations:
serverpodAuth
Request Body schema: application/json
required
email
string
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{ }

signOutAuthentication

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

basicTypes

testIntBasicTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer or null

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

testDoubleBasicTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number or null

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
0
0

testBoolBasicTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
boolean or null

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
true

testDateTimeBasicTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
dateTime
string or null

Responses

Request samples

Content type
application/json
{
  • "dateTime": "string"
}

Response samples

Content type
application/json
"string"

testStringBasicTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"string"

testByteDataBasicTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"string"

testDurationBasicTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"string"

testUuidBasicTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
"string"

cloudStorage

resetCloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

storePublicFileCloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string
byteData
string

Responses

Request samples

Content type
application/json
{
  • "path": "string",
  • "byteData": "string"
}

Response samples

Content type
application/json
null

retrievePublicFileCloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
"string"

existsPublicFileCloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
true

deletePublicFileCloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
null

getPublicUrlForFileCloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
"string"

getDirectFilePostUrlCloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
"string"

verifyDirectFileUploadCloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
true

s3CloudStorage

storePublicFileS3CloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string
byteData
string

Responses

Request samples

Content type
application/json
{
  • "path": "string",
  • "byteData": "string"
}

Response samples

Content type
application/json
null

retrievePublicFileS3CloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
"string"

existsPublicFileS3CloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
true

deletePublicFileS3CloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
null

getPublicUrlForFileS3CloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
"string"

getDirectFilePostUrlS3CloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
"string"

verifyDirectFileUploadS3CloudStorage

Authorizations:
serverpodAuth
Request Body schema: application/json
required
path
string

Responses

Request samples

Content type
application/json
{
  • "path": "string"
}

Response samples

Content type
application/json
true

columnBool

insertColumnBool

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnBool

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnBool

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnBool

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
boolean or null

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnBool

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
boolean or null

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnBool

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of booleans

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnBool

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of booleans

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnBool

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
boolean

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnBool

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
boolean

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
[
  • {
    }
]

columnDateTime

insertColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterThanColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterOrEqualThanColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

lessThanColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

lessOrEqualThanColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

betweenColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
string
max
string

Responses

Request samples

Content type
application/json
{
  • "min": "string",
  • "max": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notBetweenColumnDateTime

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
string
max
string

Responses

Request samples

Content type
application/json
{
  • "min": "string",
  • "max": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

columnDouble

insertColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number or null

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number or null

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterThanColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterOrEqualThanColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

lessThanColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

lessOrEqualThanColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

betweenColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
number
max
number

Responses

Request samples

Content type
application/json
{
  • "min": 0,
  • "max": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

notBetweenColumnDouble

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
number
max
number

Responses

Request samples

Content type
application/json
{
  • "min": 0,
  • "max": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

columnDuration

insertColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterThanColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterOrEqualThanColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

lessThanColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

lessOrEqualThanColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

betweenColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
string
max
string

Responses

Request samples

Content type
application/json
{
  • "min": "string",
  • "max": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notBetweenColumnDuration

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
string
max
string

Responses

Request samples

Content type
application/json
{
  • "min": "string",
  • "max": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

columnEnum

insertColumnEnum

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnEnum

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnEnum

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnEnum

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string (TestEnum)
Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": "one"
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnEnum

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string (TestEnum)
Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": "one"
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnEnum

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings (TestEnum)
Items Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnEnum

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings (TestEnum)
Items Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnEnum

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string (TestEnum)
Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": "one"
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnEnum

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string (TestEnum)
Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": "one"
}

Response samples

Content type
application/json
[
  • {
    }
]

columnInt

insertColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer or null

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer or null

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of integers

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of integers

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterThanColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterOrEqualThanColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

lessThanColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

lessOrEqualThanColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

betweenColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
integer
max
integer

Responses

Request samples

Content type
application/json
{
  • "min": 0,
  • "max": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

notBetweenColumnInt

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
integer
max
integer

Responses

Request samples

Content type
application/json
{
  • "min": 0,
  • "max": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

columnString

insertColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

likeColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

ilikeColumnString

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

columnUuid

insertColumnUuid

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnUuid

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnUuid

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnUuid

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnUuid

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnUuid

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnUuid

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnUuid

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnUuid

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

columnBoolLegacy

insertColumnBoolLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnBoolLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnBoolLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnBoolLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
boolean or null

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnBoolLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
boolean or null

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnBoolLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of booleans

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnBoolLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of booleans

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnBoolLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
boolean

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnBoolLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
boolean

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
[
  • {
    }
]

columnDateTimeLegacy

insertColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterThanColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterOrEqualThanColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

lessThanColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

lessOrEqualThanColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

betweenColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
string
max
string

Responses

Request samples

Content type
application/json
{
  • "min": "string",
  • "max": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notBetweenColumnDateTimeLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
string
max
string

Responses

Request samples

Content type
application/json
{
  • "min": "string",
  • "max": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

columnDoubleLegacy

insertColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number or null

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number or null

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterThanColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterOrEqualThanColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

lessThanColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

lessOrEqualThanColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
number

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

betweenColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
number
max
number

Responses

Request samples

Content type
application/json
{
  • "min": 0,
  • "max": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

notBetweenColumnDoubleLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
number
max
number

Responses

Request samples

Content type
application/json
{
  • "min": 0,
  • "max": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

columnDurationLegacy

insertColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterThanColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterOrEqualThanColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

lessThanColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

lessOrEqualThanColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

betweenColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
string
max
string

Responses

Request samples

Content type
application/json
{
  • "min": "string",
  • "max": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notBetweenColumnDurationLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
string
max
string

Responses

Request samples

Content type
application/json
{
  • "min": "string",
  • "max": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

columnEnumLegacy

insertColumnEnumLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnEnumLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnEnumLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnEnumLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string (TestEnum)
Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": "one"
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnEnumLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string (TestEnum)
Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": "one"
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnEnumLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings (TestEnum)
Items Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnEnumLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings (TestEnum)
Items Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnEnumLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string (TestEnum)
Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": "one"
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnEnumLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string (TestEnum)
Enum: "one" "two" "three"

Responses

Request samples

Content type
application/json
{
  • "value": "one"
}

Response samples

Content type
application/json
[
  • {
    }
]

columnIntLegacy

insertColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer or null

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer or null

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of integers

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of integers

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterThanColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

greaterOrEqualThanColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

lessThanColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

lessOrEqualThanColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer

Responses

Request samples

Content type
application/json
{
  • "value": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

betweenColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
integer
max
integer

Responses

Request samples

Content type
application/json
{
  • "min": 0,
  • "max": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

notBetweenColumnIntLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
min
integer
max
integer

Responses

Request samples

Content type
application/json
{
  • "min": 0,
  • "max": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

columnStringLegacy

insertColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

likeColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

ilikeColumnStringLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

columnUuidLegacy

insertColumnUuidLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "types": [
    ]
}

Response samples

Content type
application/json
null

deleteAllColumnUuidLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

findAllColumnUuidLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

equalsColumnUuidLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

notEqualsColumnUuidLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string or null

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

inSetColumnUuidLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

notInSetColumnUuidLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
Array of strings

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

isDistinctFromColumnUuidLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

isNotDistinctFromColumnUuidLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
string

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

customTypes

returnCustomClassCustomTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
data
object (CustomClass)

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{ }

returnCustomClassNullableCustomTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
data
object (CustomClass)

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{ }

returnCustomClass2CustomTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
data
object (CustomClass2)

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{ }

returnCustomClass2NullableCustomTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
data
object (CustomClass2)

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{ }

returnExternalCustomClassCustomTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
data
object (ExternalCustomClass)

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{ }

returnExternalCustomClassNullableCustomTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
data
object (ExternalCustomClass)

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{ }

returnFreezedCustomClassCustomTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
data
object (FreezedCustomClass)

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{ }

returnFreezedCustomClassNullableCustomTypes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
data
object (FreezedCustomClass)

Responses

Request samples

Content type
application/json
{
  • "data": { }
}

Response samples

Content type
application/json
{ }

basicDatabase

findSimpleDataBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
required
limit
integer
offset
integer

Responses

Request samples

Content type
application/json
{
  • "limit": 0,
  • "offset": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

findRowSimpleDataBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
required
num
integer

Responses

Request samples

Content type
application/json
{
  • "num": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "num": 0
}

findByIdSimpleDataBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "num": 0
}

insertRowSimpleDataBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "simpleData": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "num": 0
}

updateRowSimpleDataBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "simpleData": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "num": 0
}

deleteRowSimpleDataBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "simpleData": {
    }
}

Response samples

Content type
application/json
0
0

deleteWhereSimpleDataBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • 0
]

countSimpleDataBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

insertTypesBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Types)

Responses

Request samples

Content type
application/json
{
  • "value": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "anInt": 0,
  • "aBool": true,
  • "aDouble": 0,
  • "aDateTime": "string",
  • "aString": "string",
  • "aByteData": "string",
  • "aDuration": "string",
  • "aUuid": "string",
  • "anEnum": "one"
}

updateTypesBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Types)

Responses

Request samples

Content type
application/json
{
  • "value": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "anInt": 0,
  • "aBool": true,
  • "aDouble": 0,
  • "aDateTime": "string",
  • "aString": "string",
  • "aByteData": "string",
  • "aDuration": "string",
  • "aUuid": "string",
  • "anEnum": "one"
}

deleteAllBasicDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

basicDatabaseLegacy

storeTypesBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Types)

Responses

Request samples

Content type
application/json
{
  • "types": {
    }
}

Response samples

Content type
application/json
0
0

getTypesBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "anInt": 0,
  • "aBool": true,
  • "aDouble": 0,
  • "aDateTime": "string",
  • "aString": "string",
  • "aByteData": "string",
  • "aDuration": "string",
  • "aUuid": "string",
  • "anEnum": "one"
}

storeObjectWithEnumBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (ObjectWithEnum)

Responses

Request samples

Content type
application/json
{
  • "object": {
    }
}

Response samples

Content type
application/json
0
0

getObjectWithEnumBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "testEnum": "one",
  • "nullableEnum": "one",
  • "enumList": [
    ],
  • "nullableEnumList": [
    ],
  • "enumListList": [
    ]
}

getTypesRawQueryBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
0
0

countTypesRowsBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

deleteAllInTypesBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

createSimpleTestDataBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
numRows
integer

Responses

Request samples

Content type
application/json
{
  • "numRows": 0
}

Response samples

Content type
application/json
null

countSimpleDataBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

deleteAllSimpleTestDataBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

deleteSimpleTestDataLessThanBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
num
integer

Responses

Request samples

Content type
application/json
{
  • "num": 0
}

Response samples

Content type
application/json
null

findAndDeleteSimpleTestDataBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
num
integer

Responses

Request samples

Content type
application/json
{
  • "num": 0
}

Response samples

Content type
application/json
true

findSimpleDataRowsLessThanBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
num
integer
offset
integer
limit
integer
descending
boolean

Responses

Request samples

Content type
application/json
{
  • "num": 0,
  • "offset": 0,
  • "limit": 0,
  • "descending": true
}

Response samples

Content type
application/json
{
  • "rows": [
    ]
}

updateSimpleDataRowBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
num
integer
newNum
integer

Responses

Request samples

Content type
application/json
{
  • "num": 0,
  • "newNum": 0
}

Response samples

Content type
application/json
true

storeObjectWithObjectBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (ObjectWithObject)

Responses

Request samples

Content type
application/json
{
  • "object": {
    }
}

Response samples

Content type
application/json
0
0

getObjectWithObjectBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "data": {
    },
  • "nullableData": {
    },
  • "dataList": [
    ],
  • "nullableDataList": [
    ],
  • "listWithNullableData": [
    ],
  • "nullableListWithNullableData": [
    ]
}

testByteDataStoreBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
true

testDurationStoreBasicDatabaseLegacy

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
true

databaseBatch

batchInsertDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (UniqueData)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

batchInsertTypesDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

batchUpdateDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (UniqueData)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

batchUpdateTypesDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

batchUpdateWithInvalidColumnDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (UniqueData)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

batchUpdateNumberOnlyDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (UniqueData)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

batchDeleteDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (UniqueData)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

insertRelatedUniqueDataDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (RelatedUniqueData)

Responses

Request samples

Content type
application/json
{
  • "value": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uniqueDataId": 0,
  • "uniqueData": {
    },
  • "number": 0
}

findByEmailDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
required
email
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "email": "string"
}

findByIdDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "email": "string"
}

findAllDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

deleteAllDatabaseBatch

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

databaseBatchGenerated

batchInsertDatabaseBatchGenerated

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (UniqueData)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

batchInsertTypesDatabaseBatchGenerated

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

batchUpdateDatabaseBatchGenerated

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (UniqueData)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

batchUpdateTypesDatabaseBatchGenerated

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Types)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

batchDeleteDatabaseBatchGenerated

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (UniqueData)

Responses

Request samples

Content type
application/json
{
  • "value": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

insertRelatedUniqueDataDatabaseBatchGenerated

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (RelatedUniqueData)

Responses

Request samples

Content type
application/json
{
  • "value": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "uniqueDataId": 0,
  • "uniqueData": {
    },
  • "number": 0
}

findByEmailDatabaseBatchGenerated

Authorizations:
serverpodAuth
Request Body schema: application/json
required
email
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "email": "string"
}

findByIdDatabaseBatchGenerated

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": 0,
  • "email": "string"
}

findAllDatabaseBatchGenerated

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

deleteAllDatabaseBatchGenerated

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

databaseListRelationMethods

insertCityDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (City)

Responses

Request samples

Content type
application/json
{
  • "city": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "citizens": [
    ],
  • "organizations": [
    ]
}

insertOrganizationDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Organization)

Responses

Request samples

Content type
application/json
{
  • "organization": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "people": [
    ],
  • "cityId": 0,
  • "city": {
    }
}

insertPersonDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Person)

Responses

Request samples

Content type
application/json
{
  • "person": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "organizationId": 0,
  • "organization": {
    },
  • "_cityCitizensCityId": 0
}

implicitAttachRowCitizenDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (City)
object (Person)

Responses

Request samples

Content type
application/json
{
  • "city": {
    },
  • "citizen": {
    }
}

Response samples

Content type
application/json
null

implicitAttachCitizensDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (City)
Array of objects (Person)

Responses

Request samples

Content type
application/json
{
  • "city": {
    },
  • "citizens": [
    ]
}

Response samples

Content type
application/json
null

implicitDetachRowCitizensDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Person)

Responses

Request samples

Content type
application/json
{
  • "citizen": {
    }
}

Response samples

Content type
application/json
null

implicitDetachCitizensDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Person)

Responses

Request samples

Content type
application/json
{
  • "citizens": [
    ]
}

Response samples

Content type
application/json
null

cityFindByIdDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "citizens": [
    ],
  • "organizations": [
    ]
}

explicitAttachRowPeopleDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Organization)
object (Person)

Responses

Request samples

Content type
application/json
{
  • "org": {
    },
  • "person": {
    }
}

Response samples

Content type
application/json
null

explicitAttachPeopleDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Organization)
Array of objects (Person)

Responses

Request samples

Content type
application/json
{
  • "org": {
    },
  • "persons": [
    ]
}

Response samples

Content type
application/json
null

explicitDetachRowPeopleDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Person)

Responses

Request samples

Content type
application/json
{
  • "person": {
    }
}

Response samples

Content type
application/json
null

explicitDetachPeopleDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Person)

Responses

Request samples

Content type
application/json
{
  • "persons": [
    ]
}

Response samples

Content type
application/json
null

organizationFindByIdDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "people": [
    ],
  • "cityId": 0,
  • "city": {
    }
}

deleteAllDatabaseListRelationMethods

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

transactionsDatabase

removeRowTransactionsDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
required
num
integer

Responses

Request samples

Content type
application/json
{
  • "num": 0
}

Response samples

Content type
application/json
null

updateInsertDeleteTransactionsDatabase

Authorizations:
serverpodAuth
Request Body schema: application/json
required
numUpdate
integer
numInsert
integer
numDelete
integer

Responses

Request samples

Content type
application/json
{
  • "numUpdate": 0,
  • "numInsert": 0,
  • "numDelete": 0
}

Response samples

Content type
application/json
true

oneToMany

customerOrderByOrderCountAscendingOneToMany

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

customerOrderByOrderCountAscendingWhereDescriptionIsOneToMany

Authorizations:
serverpodAuth
Request Body schema: application/json
required
description
string

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

commentInsertOneToMany

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Comment)

Responses

Request samples

Content type
application/json
{
  • "comments": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

orderInsertOneToMany

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Order)

Responses

Request samples

Content type
application/json
{
  • "orders": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

customerInsertOneToMany

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (Customer)

Responses

Request samples

Content type
application/json
{
  • "customers": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

deleteAllOneToMany

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

relation

citizenFindWhereCompanyNameIsRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
companyName
string

Responses

Request samples

Content type
application/json
{
  • "companyName": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

citizenFindWhereCompanyTownNameIsRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
townName
string

Responses

Request samples

Content type
application/json
{
  • "townName": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

citizenFindOrderedByCompanyNameRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

citizenFindOrderedByCompanyTownNameRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

citizenDeleteWhereCompanyNameIsRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
companyName
string

Responses

Request samples

Content type
application/json
{
  • "companyName": "string"
}

Response samples

Content type
application/json
0
0

citizenDeleteWhereCompanyTownNameIsRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
townName
string

Responses

Request samples

Content type
application/json
{
  • "townName": "string"
}

Response samples

Content type
application/json
0
0

citizenCountWhereCompanyNameIsRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
companyName
string

Responses

Request samples

Content type
application/json
{
  • "companyName": "string"
}

Response samples

Content type
application/json
0
0

citizenCountWhereCompanyTownNameIsRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
townName
string

Responses

Request samples

Content type
application/json
{
  • "townName": "string"
}

Response samples

Content type
application/json
0
0

citizenFindAllRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Includes company and oldCompany and their respective towns

Includes company and oldCompany and their respective towns

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Includes the address

Includes the address

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

Includes company and oldCompany

Includes company and oldCompany

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

citizenFindByIdWithIncludesRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "address": {
    },
  • "companyId": 0,
  • "company": {
    },
  • "oldCompanyId": 0,
  • "oldCompany": {
    }
}

addressFindAllRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

addressFindByIdRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
id
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "street": "string",
  • "inhabitantId": 0,
  • "inhabitant": {
    }
}

findAllPostsIncludingNextAndPreviousRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

citizenAttachCompanyRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Citizen)
object (Company)

Responses

Request samples

Content type
application/json
{
  • "citizen": {
    },
  • "company": {
    }
}

Response samples

Content type
application/json
null

citizenAttachAddressRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Citizen)
object (Address)

Responses

Request samples

Content type
application/json
{
  • "citizen": {
    },
  • "address": {
    }
}

Response samples

Content type
application/json
null

citizenDetachAddressRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Citizen)

Responses

Request samples

Content type
application/json
{
  • "citizen": {
    }
}

Response samples

Content type
application/json
null

addressAttachCitizenRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Address)
object (Citizen)

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "citizen": {
    }
}

Response samples

Content type
application/json
null

addressDetachCitizenRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Address)

Responses

Request samples

Content type
application/json
{
  • "address": {
    }
}

Response samples

Content type
application/json
null

companyFindAllRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
[
  • {
    }
]

citizenInsertRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Citizen)

Responses

Request samples

Content type
application/json
{
  • "citizen": {
    }
}

Response samples

Content type
application/json
0
0

companyInsertRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Company)

Responses

Request samples

Content type
application/json
{
  • "company": {
    }
}

Response samples

Content type
application/json
0
0

townInsertRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Town)

Responses

Request samples

Content type
application/json
{
  • "town": {
    }
}

Response samples

Content type
application/json
0
0

addressInsertRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Address)

Responses

Request samples

Content type
application/json
{
  • "address": {
    }
}

Response samples

Content type
application/json
0
0

postInsertRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (Post)

Responses

Request samples

Content type
application/json
{
  • "post": {
    }
}

Response samples

Content type
application/json
0
0

deleteAllRelation

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

exceptionTest

throwNormalExceptionExceptionTest

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"string"

throwExceptionWithDataExceptionTest

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"string"

workingWithoutExceptionExceptionTest

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"string"

failedCalls

failedCallFailedCalls

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

failedDatabaseQueryFailedCalls

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

failedDatabaseQueryCaughtExceptionFailedCalls

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
true

slowCallFailedCalls

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

caughtExceptionFailedCalls

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

fieldScopes

storeObjectFieldScopes

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (ObjectFieldScopes)

Responses

Request samples

Content type
application/json
{
  • "object": {
    }
}

Response samples

Content type
application/json
null

retrieveObjectFieldScopes

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "id": 0,
  • "normal": "string",
  • "api": "string",
  • "database": "string"
}

futureCalls

makeFutureCallFutureCalls

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
null

listParameters

returnIntListListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of integers

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

returnIntListListListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • [
    ]
]

returnIntListNullableListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of integers

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

returnIntListNullableListListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • [
    ]
]

returnIntListListNullableListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • [
    ]
]

returnIntListNullableIntsListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of integers or null

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

returnNullableIntListNullableIntsListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of integers or null

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

returnDoubleListListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of numbers

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

returnDoubleListNullableDoublesListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of numbers or null

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • 0
]

returnBoolListListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of booleans

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • true
]

returnBoolListNullableBoolsListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of booleans or null

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • true
]

returnStringListListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of strings

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

returnStringListNullableStringsListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

returnDateTimeListListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of strings

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

returnDateTimeListNullableDateTimesListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

returnByteDataListListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of strings

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

returnByteDataListNullableByteDatasListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

returnSimpleDataListListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

returnSimpleDataListNullableSimpleDataListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

returnSimpleDataListNullableListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

returnNullableSimpleDataListNullableSimpleDataListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
Array of objects (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

returnDurationListListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of strings

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

returnDurationListNullableDurationsListParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
list
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "list": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

logging

logInfoLogging

Authorizations:
serverpodAuth
Request Body schema: application/json
required
message
string

Responses

Request samples

Content type
application/json
{
  • "message": "string"
}

Response samples

Content type
application/json
null

logDebugAndInfoAndErrorLogging

Authorizations:
serverpodAuth
Request Body schema: application/json
required
debug
string
info
string
error
string

Responses

Request samples

Content type
application/json
{
  • "debug": "string",
  • "info": "string",
  • "error": "string"
}

Response samples

Content type
application/json
null

twoQueriesLogging

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

loggingDisabled

logInfoLoggingDisabled

Authorizations:
serverpodAuth
Request Body schema: application/json
required
message
string

Responses

Request samples

Content type
application/json
{
  • "message": "string"
}

Response samples

Content type
application/json
null

mapParameters

returnIntMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

returnIntMapNullableMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object or null

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

returnNestedIntMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

returnIntMapNullableIntsMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

returnNullableIntMapNullableIntsMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object or null

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

returnIntIntMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

returnEnumIntMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

returnEnumMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "one",
  • "property2": "one"
}

returnDoubleMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

returnDoubleMapNullableDoublesMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": 0,
  • "property2": 0
}

returnBoolMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": true,
  • "property2": true
}

returnBoolMapNullableBoolsMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": true,
  • "property2": true
}

returnStringMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

returnStringMapNullableStringsMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

returnDateTimeMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

returnDateTimeMapNullableDateTimesMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

returnByteDataMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

returnByteDataMapNullableByteDatasMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

returnSimpleDataMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

returnSimpleDataMapNullableSimpleDataMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

returnSimpleDataMapNullableMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object or null

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

returnNullableSimpleDataMapNullableSimpleDataMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object or null

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

returnDurationMapMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

returnDurationMapNullableDurationsMapParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "map": {
    }
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

moduleSerialization

serializeModuleObjectModuleSerialization

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
true

modifyModuleObjectModuleSerialization

Authorizations:
serverpodAuth
Request Body schema: application/json
required
object
object (ModuleClass)

Responses

Request samples

Content type
application/json
{
  • "object": { }
}

Response samples

Content type
application/json
{ }

serializeNestedModuleObjectModuleSerialization

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "entity": { },
  • "list": [
    ],
  • "map": {
    }
}

namedParameters

namedParametersMethodNamedParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
namedInt
integer
intWithDefaultValue
integer
nullableInt
integer or null
nullableIntWithDefaultValue
integer or null

Responses

Request samples

Content type
application/json
{
  • "namedInt": 0,
  • "intWithDefaultValue": 0,
  • "nullableInt": 0,
  • "nullableIntWithDefaultValue": 0
}

Response samples

Content type
application/json
true

namedParametersMethodEqualIntsNamedParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
namedInt
integer
nullableInt
integer or null

Responses

Request samples

Content type
application/json
{
  • "namedInt": 0,
  • "nullableInt": 0
}

Response samples

Content type
application/json
true

optionalParameters

returnOptionalIntOptionalParameters

Authorizations:
serverpodAuth
Request Body schema: application/json
required
optionalInt
integer or null

Responses

Request samples

Content type
application/json
{
  • "optionalInt": 0
}

Response samples

Content type
application/json
0
0

redis

setSimpleDataRedis

Authorizations:
serverpodAuth
Request Body schema: application/json
required
key
string
object (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
null

setSimpleDataWithLifetimeRedis

Authorizations:
serverpodAuth
Request Body schema: application/json
required
key
string
object (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "key": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
null

getSimpleDataRedis

Authorizations:
serverpodAuth
Request Body schema: application/json
required
key
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "num": 0
}

deleteSimpleDataRedis

Authorizations:
serverpodAuth
Request Body schema: application/json
required
key
string

Responses

Request samples

Content type
application/json
{
  • "key": "string"
}

Response samples

Content type
application/json
null

resetMessageCentralTestRedis

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

listenToChannelRedis

Authorizations:
serverpodAuth
Request Body schema: application/json
required
channel
string

Responses

Request samples

Content type
application/json
{
  • "channel": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "num": 0
}

postToChannelRedis

Authorizations:
serverpodAuth
Request Body schema: application/json
required
channel
string
object (SimpleData)

Responses

Request samples

Content type
application/json
{
  • "channel": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
null

countSubscribedChannelsRedis

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

signInRequired

testMethodSignInRequired

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
true

simple

A simple endpoint that modifies a global integer. This class is meant for testing and the documentation has multiple lines.

Sets a global integer.

Sets a global integer.

Authorizations:
serverpodAuth
Request Body schema: application/json
required
value
integer or null
secondValue
integer or null

Responses

Request samples

Content type
application/json
{
  • "value": 0,
  • "secondValue": 0
}

Response samples

Content type
application/json
null

Adds 1 to the global integer.

Adds 1 to the global integer.

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
null

Retrieves a global integer.

Retrieves a global integer.

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
0
0

helloSimple

Authorizations:
serverpodAuth
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
"string"

streaming

streamingLogging

subSubDirTest

testMethodSubSubDirTest

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"string"

subDirTest

testMethodSubDirTest

Authorizations:
serverpodAuth
Request Body schema: application/json
optional
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
"string"